<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>Xinc Guide - Core Tasks</title>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
    <link rel="Stylesheet" rev="Stylesheet" href="../../css/Documentation.css" type="text/css" media="All" charset="iso-8859-1" />
</head>
<body>
<h1><a name="AppendixB"></a>Appendix B: Core Tasks</h1>

<p>
This appendix contains a reference of all core tasks, i.e. all
tasks that are needed to build a basic project.
</p>
<h2><a name="Xinc"></a>&lt;xinc/&gt;</h2>
<p> The Root Element Xinc contains one or many &lt;<a href="#Project">project</a>/&gt; elements.</p>
<h3>Supported Nested Tags</h3>
<ul>
  <li>&lt;<a href="#Project">project</a>/&gt;</li>
</ul>
<p>&nbsp;</p>
  <h2><a name="Project"></a>&lt;project/&gt;</h2>
<p> The Project Element contains all tasks that need to be run for the build process.</p>
<h3>Parent Tags</h3>
<ul>
  <li>&lt;<a href="#Xinc">xinc</a>/&gt;</li>
</ul>
<pre title="Example of how to use Project Element">
&lt;project name=&quot;ProjectName&quot;&gt;
&lt;<a href="#ConfigurationTask">configuration</a>&gt;
    &lt;<a href="#SettingTask">setting</a> name=&quot;loglevel&quot; value=&quot;0&quot;/&gt;
&lt;/configuration&gt;
...
&lt;/project&gt;
</pre>
<h3>Supported Nested Tags</h3>
<ul>
  <li>&lt;<a href="#ConfigurationTask">configuration</a>/&gt;</li>
  <li>&lt;<a href="#PropertyTask">property</a>/&gt;</li>
  <li>&lt;<a href="#TriggerTask">trigger</a>/&gt;</li>
  <li>&lt;<a href="#ModificationSetTask">modificationset</a>/&gt;</li>
  <li>&lt;<a href="#BuildersTask">builders</a>/&gt;</li>
  <li>&lt;<a href="#PublishersTask">publishers</a>/&gt;</li>
</ul>
<p>&nbsp;</p>
<h2><a name="ConfigurationTask"></a>&lt;configuration/&gt;</h2>
<p> The Configuration Task lets you specify some project specific settings.</p>
<h3>Parent Tags</h3>
<ul>
  <li>&lt;<a href="#Project">project</a>/&gt;</li>
</ul>
<pre title="Example of how to use AdhocTaskdefTask">
&lt;configuration&gt;
    &lt;<a href="#SettingTask">setting</a> name=&quot;loglevel&quot; value=&quot;0&quot;/&gt;
&lt;/configuration&gt;
</pre>

<h3>Parameters</h3>
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
      <th>Default</th>
      <th>Required</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td colspan="5">None</td>
    </tr>
  </tbody>
</table>
<h3>Supported Nested Tags</h3>
<ul>
  <li>&lt;<a href="#SettingTask">setting</a>/&gt;</li>
</ul>
<p>&nbsp;</p>
<h2><a name="SettingTask"></a>&lt;setting/&gt;</h2>
<p> The Setting Task is a nested element of the configuration task and lets you specify name value pairs.</p>
<pre title="Example of how to use SettingTask">
&lt;<a href="#ConfigurationTask">configuration</a>&gt;
    &lt;setting name=&quot;loglevel&quot; value=&quot;0&quot;/&gt;
    &lt;setting name=&quot;timezone&quot; value=&quot;Europe/Berlin&quot;/&gt;
&lt;/configuration&gt;
</pre>
<h3>Parent Tags</h3>
<ul>
  <li>&lt;<a href="#ConfigurationTask">configuration</a>/&gt;</li>
</ul>
<h3>Parameters</h3>
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
      <th>Default</th>
      <th>Required</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>name</td>
      <td>String</td>
      <td> Name of the configuration directive</td>
      <td>n/a</td>
      <td>Yes</td>
    </tr>
     <tr>
      <td>value</td>
      <td>String</td>
      <td>Value of the configuration directive</td>
      <td>n/a</td>
      <td>Yes</td>
    </tr>
  </tbody>
</table>
<h3>Supported Configuration Directives</h3>
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>loglevel</td>
      <td>Log verbosity for this project</td>
    
    </tr>
     <tr>
      <td>timezone</td>
      <td>Timezone for this project (dates will be shown accordingly)</td>
    
    </tr>
  </tbody>
</table>
<p>&nbsp;</p>
<h2><a name="PropertyTask"></a>&lt;property/&gt;</h2>
<p> The Property Task lets you define variables which you can use later in your build tasks.</p>
<pre title="Example of how to use PropertyTask">
...
    &lt;property name=&quot;dir&quot; value=&quot;/var&quot;/&gt;
    &lt;property name=&quot;www-dir&quot; value=&quot;${dir}/www&quot;/&gt;
...
</pre>
<h3>Parent Tags</h3>
<ul>
  <li>&lt;<a href="#Project">project</a>/&gt;</li>
</ul>
<h3>Parameters</h3>
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
      <th>Default</th>
      <th>Required</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>name</td>
      <td>String</td>
      <td>Name of the property</td>
      <td>n/a</td>
      <td>Yes</td>
    </tr>
    <tr>
      <td>value</td>
      <td>String</td>
      <td>Value of the property</td>
      <td>n/a</td>
      <td>Yes</td>
    </tr>
    <tr>
      <td>file</td>
      <td>String</td>
      <td>Filename of the property file to load</td>
      <td>n/a</td>
      <td>No</td>
    </tr>
    <tr>
      <td>if</td>
      <td>String</td>
      <td>Name of property to check for boolean == true. If this property name is true, the value will be set.</td>
      <td>n/a</td>
      <td>No</td>
    </tr>
  </tbody>
</table>
<p>&nbsp;</p>
<h2><a name="TriggerTask"></a>&lt;trigger/&gt;</h2>
<p> The Triggers sets the intervals/timestamps or sensors in which a build should start and goes in next stage like &lt;<a href="#ModificationSetTask">modificationset</a>/&gt;.</p>
<pre title="Example of how to use Triggers">
&lt;<a href="#Project">project</a> name=&quot;ProjectName&quot;&gt;
    &lt;trigger&gt;
        &lt;<a href="AppendixC-Triggers.html#ScheduleTask">schedule</a> interval=&quot;240&quot;/&gt;
    &lt;/trigger&gt;
...
&lt;/project&gt;
</pre>
<h3>Parent Tags</h3>
<ul>
  <li>&lt;<a href="#Project">project</a>/&gt;</li>
</ul>
<h3>Parameters</h3>
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
      <th>Default</th>
      <th>Required</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td colspan="5">None</td>
    </tr>
  </tbody>
</table>

<h3>Supported Nested Tags</h3>
<ul>
  <li>See <a href="AppendixC-Triggers.html">Appendix C: Triggers</a></li>
</ul>

<p>&nbsp;</p>
<h2><a name="ModificationSetTask"></a>&lt;modificationset/&gt;</h2>
<p> The Modificationset contains a set of listeners, checking for changes which can trigger a build.</p>
<pre title="Example of how to use ModificationSetTask">
&lt;<a href="#Project">project</a> name=&quot;ProjectName&quot;&gt;
    &lt;modificationset&gt;
        &lt;<a href="AppendixD-ModificationSet.html#BuildAlways">buildalways</a>/&gt;
    &lt;/modificationset&gt;
...
&lt;/project&gt;
</pre>
<h3>Parent Tags</h3>
<ul>
  <li>&lt;<a href="#Project">project</a>/&gt;</li>
</ul>
<h3>Parameters</h3>
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
      <th>Default</th>
      <th>Required</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td colspan="5">None</td>
    </tr>
  </tbody>
</table>

<h3>Supported Nested Tags</h3>
<ul>
  <li>See <a href="AppendixD-ModificationSet.html">Appendix D: ModificationSet</a></li>
</ul>

<p>&nbsp;</p>
<h2><a name="BuildersTask"></a>&lt;builders/&gt;</h2>
<p> The Builders Task contains a set of one to many builders which will be executed.</p>
<pre title="Example of how to use BuildersTask">
&lt;<a href="#Project">project</a> name=&quot;ProjectName&quot;&gt;
...
    &lt;builders&gt;
        &lt;<a href="AppendixE-Builders.html#PhingbuilderTask">phingbuilder</a> buildfile=&quot;build.xml&quot; target=&quot;main&quot;/&gt;
    &lt;/builders&gt;
...
&lt;/project&gt;
</pre>
<h3>Parent Tags</h3>
<ul>
  <li>&lt;<a href="#Project">project</a>/&gt;</li>
</ul>
<h3>Parameters</h3>
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
      <th>Default</th>
      <th>Required</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td colspan="5">None</td>
    </tr>
  </tbody>
</table>

<h3>Supported Nested Tags</h3>
<ul>
  <li>See <a href="AppendixE-Builders.html">Appendix E: Builders</a></li>
</ul>

<p>&nbsp;</p>
<h2><a name="PublishersTask"></a>&lt;publishers/&gt;</h2>
<p> The Publishers Task contains a set of one to many publishers which will be executed after the build.</p>
<pre title="Example of how to use PublishersTask">
&lt;<a href="#Project">project</a> name=&quot;ProjectName&quot;&gt;
...
    &lt;publishers&gt;
        &lt;<a href="AppendixF-Publishers.html#PhingpublisherTask">phingpublisher</a> buildfile=&quot;build.xml&quot; target=&quot;main&quot;/&gt;
    &lt;/publishers&gt;
...
&lt;/project&gt;
</pre>
<h3>Parent Tags</h3>
<ul>
  <li>&lt;<a href="#Project">project</a>/&gt;</li>
</ul>
<h3>Parameters</h3>
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Description</th>
      <th>Default</th>
      <th>Required</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td colspan="5">None</td>
    </tr>
  </tbody>
</table>

<h3>Supported Nested Tags</h3>
<ul>
  <li>See <a href="AppendixF-Publishers.html">Appendix F: Publishers</a></li>
</ul>
</body>
</html>
